home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / SYSLOG.PY < prev    next >
Encoding:
Text File  |  2000-05-12  |  8.6 KB  |  239 lines
  1. # -*- Mode: Python; tab-width: 4 -*-
  2.  
  3. # From: "Samual M. Rushing" <rushing@nightmare.com>
  4. # Date: Mon, 21 Apr 1997 16:10:42 -0500
  5.  
  6. # ======================================================================
  7. # Copyright 1997 by Sam Rushing
  8. # 
  9. #                         All Rights Reserved
  10. # 
  11. # Permission to use, copy, modify, and distribute this software and
  12. # its documentation for any purpose and without fee is hereby
  13. # granted, provided that the above copyright notice appear in all
  14. # copies and that both that copyright notice and this permission
  15. # notice appear in supporting documentation, and that the name of Sam
  16. # Rushing not be used in advertising or publicity pertaining to
  17. # distribution of the software without specific, written prior
  18. # permission.
  19. # 
  20. # SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  21. # INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
  22. # NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  23. # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
  24. # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  25. # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  26. # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  27. # ======================================================================
  28.  
  29. """socket interface to unix syslog.
  30. On Unix, there are usually two ways of getting to syslog: via a
  31. local unix-domain socket, or via the TCP service.
  32.  
  33. Usually "/dev/log" is the unix domain socket.  This may be different
  34. for other systems.
  35.  
  36. >>> my_client = syslog_client ('/dev/log')
  37.  
  38. Otherwise, just use the UDP version, port 514.
  39.  
  40. >>> my_client = syslog_client (('my_log_host', 514))
  41.  
  42. On win32, you will have to use the UDP version.  Note that
  43. you can use this to log to other hosts (and indeed, multiple
  44. hosts).
  45.  
  46. This module is not a drop-in replacement for the python
  47. <syslog> extension module - the interface is different.
  48.  
  49. Usage:
  50.  
  51. >>> c = syslog_client()
  52. >>> c = syslog_client ('/strange/non_standard_log_location')
  53. >>> c = syslog_client (('other_host.com', 514))
  54. >>> c.log ('testing', facility='local0', priority='debug')
  55.  
  56. """
  57.  
  58. # TODO: support named-pipe syslog.
  59. # [see ftp://sunsite.unc.edu/pub/Linux/system/Daemons/syslog-fifo.tar.z]
  60.  
  61. # from <linux/sys/syslog.h>:
  62. # ===========================================================================
  63. # priorities/facilities are encoded into a single 32-bit quantity, where the
  64. # bottom 3 bits are the priority (0-7) and the top 28 bits are the facility
  65. # (0-big number).  Both the priorities and the facilities map roughly
  66. # one-to-one to strings in the syslogd(8) source code.  This mapping is
  67. # included in this file.
  68. #
  69. # priorities (these are ordered)
  70.  
  71. LOG_EMERG       = 0     #  system is unusable 
  72. LOG_ALERT       = 1     #  action must be taken immediately 
  73. LOG_CRIT        = 2     #  critical conditions 
  74. LOG_ERR         = 3     #  error conditions 
  75. LOG_WARNING     = 4     #  warning conditions 
  76. LOG_NOTICE      = 5     #  normal but significant condition 
  77. LOG_INFO        = 6     #  informational 
  78. LOG_DEBUG       = 7     #  debug-level messages 
  79.  
  80. #  facility codes 
  81. LOG_KERN        = 0     #  kernel messages 
  82. LOG_USER        = 1     #  random user-level messages 
  83. LOG_MAIL        = 2     #  mail system 
  84. LOG_DAEMON      = 3     #  system daemons 
  85. LOG_AUTH        = 4     #  security/authorization messages 
  86. LOG_SYSLOG      = 5     #  messages generated internally by syslogd 
  87. LOG_LPR         = 6     #  line printer subsystem 
  88. LOG_NEWS        = 7     #  network news subsystem 
  89. LOG_UUCP        = 8     #  UUCP subsystem 
  90. LOG_CRON        = 9     #  clock daemon 
  91. LOG_AUTHPRIV    = 10    #  security/authorization messages (private) 
  92.  
  93. #  other codes through 15 reserved for system use 
  94. LOG_LOCAL0      = 16        #  reserved for local use 
  95. LOG_LOCAL1      = 17        #  reserved for local use 
  96. LOG_LOCAL2      = 18        #  reserved for local use 
  97. LOG_LOCAL3      = 19        #  reserved for local use 
  98. LOG_LOCAL4      = 20        #  reserved for local use 
  99. LOG_LOCAL5      = 21        #  reserved for local use 
  100. LOG_LOCAL6      = 22        #  reserved for local use 
  101. LOG_LOCAL7      = 23        #  reserved for local use 
  102.  
  103. priority_names = {
  104.     "alert":    LOG_ALERT,
  105.     "crit":     LOG_CRIT,
  106.     "debug":    LOG_DEBUG,
  107.     "emerg":    LOG_EMERG,
  108.     "err":      LOG_ERR,
  109.     "error":    LOG_ERR,        #  DEPRECATED 
  110.     "info":     LOG_INFO,
  111.     "notice":   LOG_NOTICE,
  112.     "panic":    LOG_EMERG,      #  DEPRECATED 
  113.     "warn":     LOG_WARNING,        #  DEPRECATED 
  114.     "warning":  LOG_WARNING,
  115.     }
  116.  
  117. facility_names = {
  118.     "auth":     LOG_AUTH,
  119.     "authpriv": LOG_AUTHPRIV,
  120.     "cron":     LOG_CRON,
  121.     "daemon":   LOG_DAEMON,
  122.     "kern":     LOG_KERN,
  123.     "lpr":      LOG_LPR,
  124.     "mail":     LOG_MAIL,
  125.     "news":     LOG_NEWS,
  126.     "security": LOG_AUTH,       #  DEPRECATED 
  127.     "syslog":   LOG_SYSLOG,
  128.     "user":     LOG_USER,
  129.     "uucp":     LOG_UUCP,
  130.     "local0":   LOG_LOCAL0,
  131.     "local1":   LOG_LOCAL1,
  132.     "local2":   LOG_LOCAL2,
  133.     "local3":   LOG_LOCAL3,
  134.     "local4":   LOG_LOCAL4,
  135.     "local5":   LOG_LOCAL5,
  136.     "local6":   LOG_LOCAL6,
  137.     "local7":   LOG_LOCAL7,
  138.     }
  139.  
  140. import socket
  141.  
  142. class syslog_client:
  143.     def __init__ (self, address='/dev/log'):
  144.         self.address = address
  145.         if type (address) == type(''):
  146.             try: # APUE 13.4.2 specifes /dev/log as datagram socket
  147.                 self.socket = socket.socket( socket.AF_UNIX
  148.                                                        , socket.SOCK_DGRAM)
  149.                 self.socket.connect (address)
  150.             except: # older linux may create as stream socket
  151.                 self.socket = socket.socket( socket.AF_UNIX
  152.                                                        , socket.SOCK_STREAM)
  153.                 self.socket.connect (address)
  154.             self.unix = 1
  155.         else:
  156.             self.socket = socket.socket( socket.AF_INET
  157.                                                    , socket.SOCK_DGRAM)
  158.             self.unix = 0
  159.  
  160.     # curious: when talking to the unix-domain '/dev/log' socket, a
  161.     #   zero-terminator seems to be required.  this string is placed
  162.     #   into a class variable so that it can be overridden if
  163.     #   necessary.
  164.  
  165.     log_format_string = '<%d>%s\000'
  166.  
  167.     def log (self, message, facility=LOG_USER, priority=LOG_INFO):
  168.         message = self.log_format_string % (
  169.             self.encode_priority (facility, priority),
  170.             message
  171.             )
  172.         if self.unix:
  173.             self.socket.send (message)
  174.         else:
  175.             self.socket.sendto (message, self.address)
  176.  
  177.     def encode_priority (self, facility, priority):
  178.         if type(facility) == type(''):
  179.             facility = facility_names[facility]
  180.         if type(priority) == type(''):
  181.             priority = priority_names[priority]         
  182.         return (facility<<3) | priority
  183.  
  184.     def close (self):
  185.         if self.unix:
  186.             self.socket.close()
  187.  
  188. if __name__ == '__main__':
  189.     """
  190.        Unit test for syslog_client.  Set up for the test by:
  191.     
  192.     * tail -f /var/log/allstuf (to see the "normal" log messages).
  193.  
  194.         * Running the test_logger.py script with a junk file name (which
  195.       will be opened as a Unix-domain socket). "Custom" log messages
  196.       will go here.
  197.  
  198.     * Run this script, passing the same junk file name.
  199.  
  200.     * Check that the "bogus" test throws, and that none of the rest do.
  201.  
  202.     * Check that the 'default' and 'UDP' messages show up in the tail.
  203.  
  204.     * Check that the 'non-std' message shows up in the test_logger
  205.       console.
  206.  
  207.     * Finally, kill off the tail and test_logger, and clean up the
  208.       socket file.
  209.     """
  210.     import sys, traceback
  211.  
  212.     if len( sys.argv ) != 2:
  213.        print "Usage: syslog.py localSocketFilename"
  214.        sys.exit()
  215.  
  216.     def test_client( desc, address=None ):
  217.         try:
  218.             if address:
  219.                 client = syslog_client( address )
  220.             else:
  221.                 client = syslog_client()
  222.         except:
  223.             print 'syslog_client() [%s] ctor threw' % desc
  224.             traceback.print_exc()
  225.             return
  226.  
  227.         try:
  228.             client.log( 'testing syslog_client() [%s]' % desc
  229.                       , facility='local0', priority='debug' )
  230.             print 'syslog_client.log() [%s] did not throw' % desc
  231.         except:
  232.             print 'syslog_client.log() [%s] threw' % desc
  233.             traceback.print_exc()
  234.  
  235.     test_client( 'default' )
  236.     test_client( 'bogus file', '/some/bogus/logsocket' )
  237.     test_client( 'nonstd file', sys.argv[1] )
  238.     test_client( 'UDP',  ('localhost', 514) )
  239.